when

eFMS and eGMR items in configItems and histItems elements can include a when clause that defines the conditions under which a parent EFM item is used. The when clause consists of one or more child data group elements.

This element is:

To learn about how this element relates to other elements in a CygNet device template file, see Device Template File Hierarchy.

Example

Orifice diameter is only included in the "FMS Legacy Configuration" data group if the cached value for CalcMeth is 0 or greater than 3.

<gmrMaps>

<configItems>

<eGMR_CFG_ORIFICE_DIAMETER deid="OrifD">

<when andOr="or">

<CalcMeth op="GT" value="3"/>

<CalcMeth value="0"/>

</when>

</eGMR_CFG_ORIFICE_DIAMETER>

</configItems>

</gmrMaps>

Attributes

The following table lists and describes attributes generally applicable to this element. However, not all of the attributes listed here are applicable to all EIEs. Additionally, some attributes are required for use in every device template file of a certain EIE, but others may be used on a case-by-case or device-by-device basis, depending on your specific needs. All attributes in templates are case sensitive; but the case sensitivity of attribute values is based on context.

Note: Occasionally, device template files for different EIEs use attributes of the same name that do different things. Efforts are made in this document to highlight cases where an attribute by one name does different things in different EIEs.

Attribute

Description

andOr

andOr defines the conjunction used between statements and/or expressions.

Value:
  • Only AND or OR are valid values. AND indicates that all conditions must be met; OR indicates that any one condition must be met.
  • If andOr is not used in the relevant context, the default value is AND.

op

op defines the use of a relational operator.

Value:
  • EQ: equal to
  • NE: not equal to
  • LT: less than
  • LE: less than or equal to
  • GT: greater than
  • GE: greater than or equal to
  • If an attribute value is not present, op defaults to EQ

value

value specifies a constant value. The value used must be relevant to the context in which value is used.

Value:
  • Depends on context. Often numeric, but may be string in the appropriate circumstance.

Back to top